﻿SeadragonJSProfiler = function() {
    /// <summary>Creates a Profiler.</summary>
    /// <returns type="Object"></returns>
}

SeadragonJSProfiler.prototype =
{
    isMidUpdate: function() {
        /// <summary>Returns true if an update has begun but has not yet ended.</summary>
        /// <returns type="Boolean"></returns>
    },

    getNumUpdates: function() {
        /// <summary>Returns the number of updates that have been profiled.</summary>
        /// <returns type="Number"></returns>
    },

    //Update time accessors
    getAvgUpdateTime: function() {
        /// <summary>Returns the average length of each update.</summary>
        /// <returns type="Number"></returns>
    },

    getMinUpdateTime: function() {
        /// <summary>Returns the length of the shortest update.</summary>
        /// <returns type="Number"></returns>
    },

    getMaxUpdateTime: function() {
        /// <summary>Returns the length of the longest update.</summary>
        /// <returns type="Number"></returns>
    },

    //Idle Time Accessors
    getAvgIdleTime: function() {
        /// <summary>Returns the average length of each idle period between two updates.</summary>
        /// <returns type="Number"></returns>
    },

    getMinIdleTime: function() {
        /// <summary>Returns the length of the shortest idle period between two updates.</summary>
        /// <returns type="Number"></returns>
    },

    getMaxIdleTime: function() {
        /// <summary>Returns the length of the longest idle period between two updates.</summary>
        /// <returns type="Number"></returns>
    },

    //Idle Time Accessors
    beginUpdate: function() {
        /// <summary>Signals to the Profiler that an update has begun.</summary>
    },

    endUpdate: function() {
        /// <summary>Returns the length of the shortest idle period between two updates.</summary>
    },

    clearProfile: function() {
        /// <summary>Returns the length of the longest idle period between two updates.</summary>
    }
}
